Skip to main content

OperatorContract

Contracts • API

Holograph SDK Reference / Contracts / OperatorContract

Class: OperatorContract

Remarks​

The Operator holds and manages the protocol operator.

Extends​

Constructors​

new OperatorContract(parentLogger)​

new OperatorContract(parentLogger?): OperatorContract

Parameters​

• parentLogger?: HolographLogger

Returns​

OperatorContract

Overrides​

HolographBaseContract.constructor

Source​

packages/sdk/src/contracts/operator.contract.ts:20

Properties​

_abi​

protected readonly _abi: Abi

Inherited from​

HolographBaseContract._abi

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:43

_addresses​

protected readonly _addresses: Record<number, 0x${string}> = {}

The record of addresses per chainId.

Inherited from​

HolographBaseContract._addresses

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:36

_config​

protected readonly _config: Config

Inherited from​

HolographBaseContract._config

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:41

_logger​

protected _logger: HolographLogger

Inherited from​

HolographBaseContract._logger

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:42

_providers​

protected readonly _providers: Providers

Inherited from​

HolographBaseContract._providers

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:37

_walletManager?​

protected optional _walletManager: HolographWalletManager

Inherited from​

HolographBaseContract._walletManager

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:38

networks​

readonly networks: Network[]

The list of networks in which the contract was instantiated.

Inherited from​

HolographBaseContract.networks

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:34

Methods​

_callContractFunction()​

protected _callContractFunction<TAbi>(__namedParameters): Promise<string | string[]>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: CallContractFunctionArgs<TAbi>

Returns​

Promise<string | string[]>

Inherited from​

HolographBaseContract._callContractFunction

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:147

_estimateContractGas()​

protected _estimateContractGas<TAbi>(__namedParameters): Promise<bigint>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: EstimateContractGasArgs<TAbi>

Returns​

Promise<bigint>

Inherited from​

HolographBaseContract._estimateContractGas

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:106

_getContractFunction()​

private _getContractFunction(__namedParameters): Promise<string | string[]>

Parameters​

• __namedParameters: GetContractFunctionArgs<[object, object, object, object]>

Returns​

Promise<string | string[]>

Source​

packages/sdk/src/contracts/operator.contract.ts:48

_readContract()​

protected _readContract<TAbi>(__namedParameters): Promise<unknown>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: ReadContractArgs<TAbi>

Returns​

Promise<unknown>

Inherited from​

HolographBaseContract._readContract

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:138

_simulateContract()​

protected _simulateContract<TAbi>(__namedParameters): Promise<any>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: SimulateContractArgs<TAbi>

Returns​

Promise<any>

Inherited from​

HolographBaseContract._simulateContract

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:72

_writeContract()​

protected _writeContract<TAbi>(__namedParameters): Promise<0x${string}>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: WriteContractArgs<TAbi>

Returns​

Promise<0x${string}>

Inherited from​

HolographBaseContract._writeContract

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:122

bondUtilityToken()​

bondUtilityToken(chainId, operator, amount, pod, wallet?): Promise<string | string[]>

Bonds utility tokens and become an operator. An operator can only bond to one pod at a time, per network.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• operator: 0x${string}

The address of operator to bond (can be an ownable smart contract).

• amount: bigint

The utility token amount to bond (can be greater than minimum).

• pod: bigint

The number of pod to bond to (can be for one that does not exist yet).

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:444

crossChainMessage()​

crossChainMessage(chainId, bridgeInRequestPayload, wallet?): Promise<string | string[]>

Receives a cross-chain message. This function is restricted for use by Holograph Messaging Module only.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• bridgeInRequestPayload: 0x${string}

The entire cross chain message payload.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:396

estimateContractFunctionGas()​

estimateContractFunctionGas(__namedParameters): Promise<bigint>

Parameters​

• __namedParameters: EstimateContractFunctionGasArgs<[object, object, object, object]>

Returns​

Promise<bigint>

Source​

packages/sdk/src/contracts/operator.contract.ts:58

executeJob()​

executeJob(chainId, bridgeInRequestPayload, wallet?): Promise<string | string[]>

Executes an available operator job. When making this call, if operating criteria is not met, the call will revert.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• bridgeInRequestPayload: 0x${string}

The entire cross chain message payload.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:364

getAddress()​

readonly getAddress(chainId): Promise<0x${string}>

Get the HolographOperator contract address according to environment and chainId module.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<0x${string}>

The HolographOperator contract address in the provided network.

Source​

packages/sdk/src/contracts/operator.contract.ts:38

getBondedAmount()​

readonly getBondedAmount(chainId, operator): Promise<string | string[]>

Get an operator's currently bonded amount.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• operator: 0x${string}

address of operator to check.

Returns​

Promise<string | string[]>

amount total number of utility token bonded.

Source​

packages/sdk/src/contracts/operator.contract.ts:154

getBondedPod()​

readonly getBondedPod(chainId, operator): Promise<string | string[]>

Get an operator's currently bonded pod.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• operator: 0x${string}

address of operator to check.

Returns​

Promise<string | string[]>

pod number that operator is bonded on, returns zero if not bonded or selected for job.

Source​

packages/sdk/src/contracts/operator.contract.ts:165

getBondedPodIndex()​

readonly getBondedPodIndex(chainId, operator): Promise<string | string[]>

Get an operator's currently bonded pod index.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• operator: 0x${string}

address of operator to check.

Returns​

Promise<string | string[]>

index currently bonded pod's operator index, returns zero if not in pod or moved out for active job.

Source​

packages/sdk/src/contracts/operator.contract.ts:176

getBridgeByNetworks()​

readonly getBridgeByNetworks(chainIds?): Promise<HolographByNetworksResponse>

Get the Holograph Bridge contract address by network.

Parameters​

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the Holograph Bridge contract address per network.

Source​

packages/sdk/src/contracts/operator.contract.ts:224

getClientByChainId()​

readonly getClientByChainId(chainId): Promise<object>

Get the Viem client for a certain network.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<object>

The Viem client object.

account​

account: undefined

The Account of the Client.

batch?​

optional batch: object

Flags for batch settings.

batch.multicall?​

optional multicall: boolean | { batchSize?: number | undefined; wait?: number | undefined; }

Toggle to enable eth_call multicall aggregation.

cacheTime​

cacheTime: number

Time (in ms) that cached data will remain in memory.

call()​

call: (parameters) => Promise<CallReturnType>

Executes a new message call immediately without submitting a transaction to the network.

Parameters​

• parameters: CallParameters<undefined | Chain>

Returns​

Promise<CallReturnType>

The call data. CallReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const data = await client.call({
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
chain​

chain: undefined | Chain

Chain for the client.

createBlockFilter()​

createBlockFilter: () => Promise<object>

Creates a Filter to listen for new block hashes that can be used with getFilterChanges.

Returns​

Promise<object>

Filter. CreateBlockFilterReturnType

id​

id: 0x${string}

request​

request: EIP1193RequestFn<readonly [object, object, object]>

type​

type: "block"

Example​
import { createPublicClient, createBlockFilter, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await createBlockFilter(client)
// { id: "0x345a6572337856574a76364e457a4366", type: 'block' }
createContractEventFilter()​

createContractEventFilter: <TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args) => Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>

Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.

Type parameters​

• TAbi extends readonly unknown[] | Abi

• TEventName extends undefined | string

• TArgs extends undefined | readonly unknown[] | Record<string, unknown>

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args: CreateContractEventFilterParameters<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>

CreateContractEventFilterParameters

Returns​

Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>

Filter. CreateContractEventFilterReturnType

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createContractEventFilter({
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
})
createEventFilter()​

createEventFilter: <TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args?) => Promise<{ [K in keyof Filter<"event", TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock>]: Filter<"event", TAbiEvents, ... 4 more ..., TToBlock>[K]; }>

Creates a Filter to listen for new events that can be used with getFilterChanges.

Type parameters​

• TAbiEvent extends undefined | AbiEvent = undefined

• TAbiEvents extends undefined | readonly unknown[] | readonly AbiEvent[] = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

• _EventName extends undefined | string = MaybeAbiEventName<TAbiEvent>

• _Args extends undefined | readonly unknown[] | Record<string, unknown> = undefined

Parameters​

• args?: CreateEventFilterParameters<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>

CreateEventFilterParameters

Returns​

Promise<{ [K in keyof Filter<"event", TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock>]: Filter<"event", TAbiEvents, ... 4 more ..., TToBlock>[K]; }>

Filter. CreateEventFilterReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
})
createPendingTransactionFilter()​

createPendingTransactionFilter: () => Promise<object>

Creates a Filter to listen for new pending transaction hashes that can be used with getFilterChanges.

Returns​

Promise<object>

Filter. CreateBlockFilterReturnType

id​

id: 0x${string}

request​

request: EIP1193RequestFn<readonly [object, object, object]>

type​

type: "transaction"

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createPendingTransactionFilter()
// { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' }
estimateContractGas()​

estimateContractGas: <TChain, abi, functionName, args>(args) => Promise<bigint>

Estimates the gas required to successfully execute a contract write function call.

Type parameters​

• TChain extends undefined | Chain

• abi extends readonly unknown[] | Abi

• functionName extends string

• args extends unknown

Parameters​

• args: EstimateContractGasParameters<abi, functionName, args, TChain>

EstimateContractGasParameters

Returns​

Promise<bigint>

The gas estimate (in wei). EstimateContractGasReturnType

Remarks​

Internally, uses a Public Client to call the estimateGas action with ABI-encoded data.

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gas = await client.estimateContractGas({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint() public']),
functionName: 'mint',
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
})
estimateFeesPerGas()​

estimateFeesPerGas: <TChainOverride, TType>(args?) => Promise<EstimateFeesPerGasReturnType>

Returns an estimate for the fees per gas for a transaction to be included in the next block.

Type parameters​

• TChainOverride extends undefined | Chain = undefined

• TType extends FeeValuesType = "eip1559"

Parameters​

• args?: EstimateFeesPerGasParameters<undefined | Chain, TChainOverride, TType>

Returns​

Promise<EstimateFeesPerGasReturnType>

An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateFeesPerGas()
// { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
estimateGas()​

estimateGas: (args) => Promise<bigint>

Estimates the gas necessary to complete a transaction without submitting it to the network.

Parameters​

• args: EstimateGasParameters<undefined | Chain>

EstimateGasParameters

Returns​

Promise<bigint>

The gas estimate (in wei). EstimateGasReturnType

Example​
import { createPublicClient, http, parseEther } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gasEstimate = await client.estimateGas({
account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1'),
})
estimateMaxPriorityFeePerGas()​

estimateMaxPriorityFeePerGas: <TChainOverride>(args?) => Promise<bigint>

Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block.

Type parameters​

• TChainOverride extends undefined | Chain = undefined

Parameters​

• args?

• args.chain?: null | TChainOverride

Returns​

Promise<bigint>

An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePerGasReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas()
// 10000000n
extend()​

extend: <client>(fn) => Client<Transport, undefined | Chain, undefined, PublicRpcSchema, { [K in keyof client]: client[K]; } & PublicActions<Transport, undefined | Chain>>

Type parameters​

• client extends { [x: string]: unknown; account?: undefined; batch?: undefined; cacheTime?: undefined; chain?: undefined; key?: undefined; name?: undefined; pollingInterval?: undefined; request?: undefined; transport?: undefined; type?: undefined; uid?: undefined; } & Partial<ExtendableProtectedActions<Transport, undefined | Chain, undefined>>

Parameters​

• fn

Returns​

Client<Transport, undefined | Chain, undefined, PublicRpcSchema, { [K in keyof client]: client[K]; } & PublicActions<Transport, undefined | Chain>>

getBalance()​

getBalance: (args) => Promise<bigint>

Returns the balance of an address in wei.

Parameters​

• args: GetBalanceParameters

GetBalanceParameters

Returns​

Promise<bigint>

The balance of the address in wei. GetBalanceReturnType

Remarks​

You can convert the balance to ether units with formatEther.

const balance = await getBalance(client, {
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
blockTag: 'safe'
})
const balanceAsEther = formatEther(balance)
// "6.942"
Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const balance = await client.getBalance({
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
// 10000000000000000000000n (wei)
getBlock()​

getBlock: <TIncludeTransactions, TBlockTag>(args?) => Promise<{ number: TBlockTag extends "pending" ? null : bigint; gasLimit: bigint; hash: TBlockTag extends "pending" ? null : `0x${string}`; nonce: TBlockTag extends "pending" ? null : `0x${string}`; ... 21 more ...; transactions: TIncludeTransactions extends true ? ({ ...; } | ... 2 more ... | { ...; })[] : `0x${string}`[]; }>

Returns information about a block at a block number, hash, or tag.

Type parameters​

• TIncludeTransactions extends boolean = false

• TBlockTag extends BlockTag = "latest"

Parameters​

• args?: GetBlockParameters<TIncludeTransactions, TBlockTag>

GetBlockParameters

Returns​

Promise<{ number: TBlockTag extends "pending" ? null : bigint; gasLimit: bigint; hash: TBlockTag extends "pending" ? null : `0x${string}`; nonce: TBlockTag extends "pending" ? null : `0x${string}`; ... 21 more ...; transactions: TIncludeTransactions extends true ? ({ ...; } | ... 2 more ... | { ...; })[] : `0x${string}`[]; }>

Information about the block. GetBlockReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const block = await client.getBlock()
getBlockNumber()​

getBlockNumber: (args?) => Promise<bigint>

Returns the number of the most recent block seen.

Parameters​

• args?: GetBlockNumberParameters

GetBlockNumberParameters

Returns​

Promise<bigint>

The number of the block. GetBlockNumberReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const blockNumber = await client.getBlockNumber()
// 69420n
getBlockTransactionCount()​

getBlockTransactionCount: (args?) => Promise<number>

Returns the number of Transactions at a block number, hash, or tag.

Parameters​

• args?: GetBlockTransactionCountParameters

GetBlockTransactionCountParameters

Returns​

Promise<number>

The block transaction count. GetBlockTransactionCountReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const count = await client.getBlockTransactionCount()
getBytecode()​

getBytecode: (args) => Promise<GetBytecodeReturnType>

Retrieves the bytecode at an address.

Parameters​

• args: GetBytecodeParameters

GetBytecodeParameters

Returns​

Promise<GetBytecodeReturnType>

The contract's bytecode. GetBytecodeReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const code = await client.getBytecode({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
getChainId()​

getChainId: () => Promise<number>

Returns the chain ID associated with the current network.

Returns​

Promise<number>

The current chain ID. GetChainIdReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const chainId = await client.getChainId()
// 1
getContractEvents()​

getContractEvents: <abi, eventName, strict, fromBlock, toBlock>(args) => Promise<GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>>

Returns a list of event logs emitted by a contract.

Type parameters​

• abi extends readonly unknown[] | Abi

• eventName extends undefined | string = undefined

• strict extends undefined | boolean = undefined

• fromBlock extends undefined | bigint | BlockTag = undefined

• toBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args: GetContractEventsParameters<abi, eventName, strict, fromBlock, toBlock>

Returns​

Promise<GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>>

A list of event logs. GetContractEventsReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { wagmiAbi } from './abi'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const logs = await client.getContractEvents(client, {
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: wagmiAbi,
eventName: 'Transfer'
})
getEnsAddress()​

getEnsAddress: (args) => Promise<GetEnsAddressReturnType>

Gets address for ENS name.

Parameters​

• args: { blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; coinType?: number | undefined; gatewayUrls?: string[] | undefined; name: string; strict?: boolean | undefined; universalResolverAddress?: `0x${string}` | undefined; }

GetEnsAddressParameters

Returns​

Promise<GetEnsAddressReturnType>

Address for ENS name or null if not found. GetEnsAddressReturnType

Remarks​

Calls resolve(bytes, bytes) on ENS Universal Resolver Contract.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const ensAddress = await client.getEnsAddress({
name: normalize('wevm.eth'),
})
// '0xd2135CfB216b74109775236E36d4b433F1DF507B'
getEnsAvatar()​

getEnsAvatar: (args) => Promise<GetEnsAvatarReturnType>

Gets the avatar of an ENS name.

Parameters​

• args: { name: string; blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; gatewayUrls?: string[] | undefined; strict?: boolean | undefined; universalResolverAddress?: `0x${string}` | undefined; assetGatewayUrls?: AssetGatewayUrls | undefined; }

GetEnsAvatarParameters

Returns​

Promise<GetEnsAvatarReturnType>

Avatar URI or null if not found. GetEnsAvatarReturnType

Remarks​

Calls getEnsText with key set to 'avatar'.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const ensAvatar = await client.getEnsAvatar({
name: normalize('wevm.eth'),
})
// 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio'
getEnsName()​

getEnsName: (args) => Promise<GetEnsNameReturnType>

Gets primary name for specified address.

Parameters​

• args: { blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; address: `0x${string}`; gatewayUrls?: string[] | undefined; strict?: boolean | undefined; universalResolverAddress?: `0x${string}` | undefined; }

GetEnsNameParameters

Returns​

Promise<GetEnsNameReturnType>

Name or null if not found. GetEnsNameReturnType

Remarks​

Calls reverse(bytes) on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const ensName = await client.getEnsName({
address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
})
// 'wevm.eth'
getEnsResolver()​

getEnsResolver: (args) => Promise<0x${string}>

Gets resolver for ENS name.

Parameters​

• args: { blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; name: string; universalResolverAddress?: `0x${string}` | undefined; }

GetEnsResolverParameters

Returns​

Promise<0x${string}>

Address for ENS resolver. GetEnsResolverReturnType

Remarks​

Calls findResolver(bytes) on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const resolverAddress = await client.getEnsResolver({
name: normalize('wevm.eth'),
})
// '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41'
getEnsText()​

getEnsText: (args) => Promise<GetEnsTextReturnType>

Gets a text record for specified ENS name.

Parameters​

• args: { blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; name: string; gatewayUrls?: string[] | undefined; key: string; strict?: boolean | undefined; universalResolverAddress?: `0x${string}` | undefined; }

GetEnsTextParameters

Returns​

Promise<GetEnsTextReturnType>

Address for ENS resolver. GetEnsTextReturnType

Remarks​

Calls resolve(bytes, bytes) on ENS Universal Resolver Contract.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const twitterRecord = await client.getEnsText({
name: normalize('wevm.eth'),
key: 'com.twitter',
})
// 'wagmi_sh'
getFeeHistory()​

getFeeHistory: (args) => Promise<GetFeeHistoryReturnType>

Returns a collection of historical gas information.

Parameters​

• args: GetFeeHistoryParameters

GetFeeHistoryParameters

Returns​

Promise<GetFeeHistoryReturnType>

The gas estimate (in wei). GetFeeHistoryReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const feeHistory = await client.getFeeHistory({
blockCount: 4,
rewardPercentiles: [25, 75],
})
getFilterChanges()​

getFilterChanges: <TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

Returns a list of logs or hashes based on a Filter since the last time it was called.

Type parameters​

• TFilterType extends FilterType

• TAbi extends undefined | readonly unknown[] | Abi

• TEventName extends undefined | string

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args: GetFilterChangesParameters<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>

GetFilterChangesParameters

Returns​

Promise<GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

Logs or hashes. GetFilterChangesReturnType

Remarks​

A Filter can be created from the following actions:

Depending on the type of filter, the return value will be different:

  • If the filter was created with createContractEventFilter or createEventFilter, it returns a list of logs.
  • If the filter was created with createPendingTransactionFilter, it returns a list of transaction hashes.
  • If the filter was created with createBlockFilter, it returns a list of block hashes.
Example​
// Blocks
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createBlockFilter()
const hashes = await client.getFilterChanges({ filter })
Example​
// Contract Events
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createContractEventFilter({
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
eventName: 'Transfer',
})
const logs = await client.getFilterChanges({ filter })
Example​
// Raw Events
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'),
})
const logs = await client.getFilterChanges({ filter })
Example​
// Transactions
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createPendingTransactionFilter()
const hashes = await client.getFilterChanges({ filter })
getFilterLogs()​

getFilterLogs: <TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

Returns a list of event logs since the filter was created.

Type parameters​

• TAbi extends undefined | readonly unknown[] | Abi

• TEventName extends undefined | string

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args: GetFilterLogsParameters<TAbi, TEventName, TStrict, TFromBlock, TToBlock>

GetFilterLogsParameters

Returns​

Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

A list of event logs. GetFilterLogsReturnType

Remarks​

getFilterLogs is only compatible with event filters.

Example​
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'),
})
const logs = await client.getFilterLogs({ filter })
getGasPrice()​

getGasPrice: () => Promise<bigint>

Returns the current price of gas (in wei).

Returns​

Promise<bigint>

The gas price (in wei). GetGasPriceReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gasPrice = await client.getGasPrice()
getLogs()​

getLogs: <TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>(args?) => Promise<GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>

Returns a list of event logs matching the provided parameters.

Type parameters​

• TAbiEvent extends undefined | AbiEvent = undefined

• TAbiEvents extends undefined | readonly unknown[] | readonly AbiEvent[] = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args?: GetLogsParameters<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>

GetLogsParameters

Returns​

Promise<GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>

A list of event logs. GetLogsReturnType

Example​
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const logs = await client.getLogs()
getProof()​

getProof: (args) => Promise<GetProofReturnType>

Returns the account and storage values of the specified account including the Merkle-proof.

Parameters​

• args: GetProofParameters

Returns​

Promise<GetProofReturnType>

Proof data. GetProofReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const block = await client.getProof({
address: '0x...',
storageKeys: ['0x...'],
})
getStorageAt()​

getStorageAt: (args) => Promise<GetStorageAtReturnType>

Returns the value from a storage slot at a given address.

Parameters​

• args: GetStorageAtParameters

GetStorageAtParameters

Returns​

Promise<GetStorageAtReturnType>

The value of the storage slot. GetStorageAtReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { getStorageAt } from 'viem/contract'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const code = await client.getStorageAt({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
slot: toHex(0),
})
getTransaction()​

getTransaction: <TBlockTag>(args) => Promise<{ type: "legacy"; gasPrice: bigint; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId?: number | undefined; nonce: number; from: `0x${string}`; gas: bigint; ... 10 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ... | { type: "eip2930"; gasPrice: bigint; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas?: undefined; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true : fal... | { type: "eip1559"; gasPrice?: undefined; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas?: undefined; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true :... | { type: "eip4844"; gasPrice?: undefined; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas: bigint; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true : fal...>

Returns information about a Transaction given a hash or block identifier.

Type parameters​

• TBlockTag extends BlockTag = "latest"

Parameters​

• args: GetTransactionParameters<TBlockTag>

GetTransactionParameters

Returns​

Promise<{ type: "legacy"; gasPrice: bigint; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId?: number | undefined; nonce: number; from: `0x${string}`; gas: bigint; ... 10 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ... | { type: "eip2930"; gasPrice: bigint; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas?: undefined; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true : fal... | { type: "eip1559"; gasPrice?: undefined; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas?: undefined; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true :... | { type: "eip4844"; gasPrice?: undefined; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas: bigint; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true : fal...>

The transaction information. GetTransactionReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transaction = await client.getTransaction({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
getTransactionConfirmations()​

getTransactionConfirmations: (args) => Promise<bigint>

Returns the number of blocks passed (confirmations) since the transaction was processed on a block.

Parameters​

• args: GetTransactionConfirmationsParameters<undefined | Chain>

GetTransactionConfirmationsParameters

Returns​

Promise<bigint>

The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. GetTransactionConfirmationsReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const confirmations = await client.getTransactionConfirmations({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
getTransactionCount()​

getTransactionCount: (args) => Promise<number>

Returns the number of Transactions an Account has broadcast / sent.

Parameters​

• args: GetTransactionCountParameters

GetTransactionCountParameters

Returns​

Promise<number>

The number of transactions an account has sent. GetTransactionCountReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionCount = await client.getTransactionCount({
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
getTransactionReceipt()​

getTransactionReceipt: (args) => Promise<TransactionReceipt>

Returns the Transaction Receipt given a Transaction hash.

Parameters​

• args: GetTransactionReceiptParameters

GetTransactionReceiptParameters

Returns​

Promise<TransactionReceipt>

The transaction receipt. GetTransactionReceiptReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionReceipt = await client.getTransactionReceipt({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
key​

key: string

A key for the client.

multicall()​

multicall: <contracts, allowFailure>(args) => Promise<MulticallReturnType<contracts, allowFailure>>

Similar to readContract, but batches up multiple functions on a contract in a single RPC call via the multicall3 contract.

Type parameters​

• contracts extends readonly unknown[]

• allowFailure extends boolean = true

Parameters​

• args: MulticallParameters<contracts, allowFailure>

MulticallParameters

Returns​

Promise<MulticallReturnType<contracts, allowFailure>>

An array of results with accompanying status. MulticallReturnType

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const abi = parseAbi([
'function balanceOf(address) view returns (uint256)',
'function totalSupply() view returns (uint256)',
])
const result = await client.multicall({
contracts: [
{
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi,
functionName: 'balanceOf',
args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
},
{
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi,
functionName: 'totalSupply',
},
],
})
// [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }]
name​

name: string

A name for the client.

pollingInterval​

pollingInterval: number

Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.

prepareTransactionRequest()​

prepareTransactionRequest: <TParameterType, TChainOverride, TAccountOverride>(args) => Promise<PrepareTransactionRequestReturnType<Chain, undefined | Account, TChainOverride, TAccountOverride, TParameterType>>

Prepares a transaction request for signing.

Type parameters​

• TParameterType extends PrepareTransactionRequestParameterType

• TChainOverride extends undefined | Chain = undefined

• TAccountOverride extends undefined | 0x${string} | Account = undefined

Parameters​

• args: PrepareTransactionRequestParameters<undefined | Chain, undefined | Account, TChainOverride, TAccountOverride, TParameterType>

PrepareTransactionRequestParameters

Returns​

Promise<PrepareTransactionRequestReturnType<Chain, undefined | Account, TChainOverride, TAccountOverride, TParameterType>>

The transaction request. PrepareTransactionRequestReturnType

Example​
import { createWalletClient, custom } from 'viem'
import { mainnet } from 'viem/chains'

const client = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum),
})
const request = await client.prepareTransactionRequest({
account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
to: '0x0000000000000000000000000000000000000000',
value: 1n,
})
Example​
// Account Hoisting
import { createWalletClient, http } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
import { mainnet } from 'viem/chains'

const client = createWalletClient({
account: privateKeyToAccount('0x…'),
chain: mainnet,
transport: custom(window.ethereum),
})
const request = await client.prepareTransactionRequest({
to: '0x0000000000000000000000000000000000000000',
value: 1n,
})
readContract()​

readContract: <abi, functionName, args>(args) => Promise<ReadContractReturnType<abi, functionName, args>>

Calls a read-only function on a contract, and returns the response.

Type parameters​

• abi extends readonly unknown[] | Abi

• functionName extends string

• args extends unknown

Parameters​

• args: ReadContractParameters<abi, functionName, args>

ReadContractParameters

Returns​

Promise<ReadContractReturnType<abi, functionName, args>>

The response from the contract. Type is inferred. ReadContractReturnType

Remarks​

A "read-only" function (constant function) on a Solidity contract is denoted by a view or pure keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.

Internally, uses a Public Client to call the call action with ABI-encoded data.

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
import { readContract } from 'viem/contract'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.readContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function balanceOf(address) view returns (uint256)']),
functionName: 'balanceOf',
args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
})
// 424122n
request​

request: EIP1193RequestFn<PublicRpcSchema>

Request function wrapped with friendly error handling

sendRawTransaction()​

sendRawTransaction: (args) => Promise<0x${string}>

Sends a signed transaction to the network

Parameters​

• args: SendRawTransactionParameters

Returns​

Promise<0x${string}>

The transaction hash. SendRawTransactionReturnType

Example​
import { createWalletClient, custom } from 'viem'
import { mainnet } from 'viem/chains'
import { sendRawTransaction } from 'viem/wallet'

const client = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum),
})

const hash = await client.sendRawTransaction({
serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33'
})
simulateContract()​

simulateContract: <abi, functionName, args, chainOverride, accountOverride>(args) => Promise<SimulateContractReturnType<abi, functionName, args, undefined | Chain, undefined | Account, chainOverride, accountOverride>>

Simulates/validates a contract interaction. This is useful for retrieving return data and revert reasons of contract write functions.

Type parameters​

• abi extends readonly unknown[] | Abi

• functionName extends string

• args extends unknown

• chainOverride extends undefined | Chain

• accountOverride extends undefined | 0x${string} | Account = undefined

Parameters​

• args: SimulateContractParameters<abi, functionName, args, undefined | Chain, chainOverride, accountOverride>

SimulateContractParameters

Returns​

Promise<SimulateContractReturnType<abi, functionName, args, undefined | Chain, undefined | Account, chainOverride, accountOverride>>

The simulation result and write request. SimulateContractReturnType

Remarks​

This function does not require gas to execute and does not change the state of the blockchain. It is almost identical to readContract, but also supports contract write functions.

Internally, uses a Public Client to call the call action with ABI-encoded data.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.simulateContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint(uint32) view returns (uint32)']),
functionName: 'mint',
args: ['69420'],
account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
transport​

transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>

The RPC transport

type​

type: string

The type of client.

uid​

uid: string

A unique ID for the client.

uninstallFilter()​

uninstallFilter: (args) => Promise<boolean>

Destroys a Filter that was created from one of the following Actions:

Parameters​

• args: UninstallFilterParameters

UninstallFilterParameters

Returns​

Promise<boolean>

A boolean indicating if the Filter was successfully uninstalled. UninstallFilterReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { createPendingTransactionFilter, uninstallFilter } from 'viem/public'

const filter = await client.createPendingTransactionFilter()
const uninstalled = await client.uninstallFilter({ filter })
// true
verifyMessage()​

verifyMessage: (args) => Promise<boolean>

Parameters​

• args: VerifyMessageParameters

Returns​

Promise<boolean>

verifyTypedData()​

verifyTypedData: (args) => Promise<boolean>

Parameters​

• args: VerifyTypedDataParameters

Returns​

Promise<boolean>

waitForTransactionReceipt()​

waitForTransactionReceipt: (args) => Promise<TransactionReceipt>

Waits for the Transaction to be included on a Block (one confirmation), and then returns the Transaction Receipt. If the Transaction reverts, then the action will throw an error.

Parameters​

• args: WaitForTransactionReceiptParameters<undefined | Chain>

WaitForTransactionReceiptParameters

Returns​

Promise<TransactionReceipt>

The transaction receipt. WaitForTransactionReceiptReturnType

Remarks​

The waitForTransactionReceipt action additionally supports Replacement detection (e.g. sped up Transactions).

Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce.

There are 3 types of Transaction Replacement reasons:

  • repriced: The gas price has been modified (e.g. different maxFeePerGas)
  • cancelled: The Transaction has been cancelled (e.g. value === 0n)
  • replaced: The Transaction has been replaced (e.g. different value or data)
Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionReceipt = await client.waitForTransactionReceipt({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
watchBlockNumber()​

watchBlockNumber: (args) => WatchBlockNumberReturnType

Watches and returns incoming block numbers.

Parameters​

• args: WatchBlockNumberParameters

WatchBlockNumberParameters

Returns​

WatchBlockNumberReturnType

A function that can be invoked to stop watching for new block numbers. WatchBlockNumberReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = await client.watchBlockNumber({
onBlockNumber: (blockNumber) => console.log(blockNumber),
})
watchBlocks()​

watchBlocks: <TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType

Watches and returns information for incoming blocks.

Type parameters​

• TIncludeTransactions extends boolean = false

• TBlockTag extends BlockTag = "latest"

Parameters​

• args: WatchBlocksParameters<Transport, undefined | Chain, TIncludeTransactions, TBlockTag>

WatchBlocksParameters

Returns​

WatchBlocksReturnType

A function that can be invoked to stop watching for new block numbers. WatchBlocksReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = await client.watchBlocks({
onBlock: (block) => console.log(block),
})
watchContractEvent()​

watchContractEvent: <TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType

Watches and returns emitted contract event logs.

Type parameters​

• TAbi extends readonly unknown[] | Abi

• TEventName extends string

• TStrict extends undefined | boolean = undefined

Parameters​

• args: WatchContractEventParameters<TAbi, TEventName, TStrict, Transport>

WatchContractEventParameters

Returns​

WatchContractEventReturnType

A function that can be invoked to stop watching for new event logs. WatchContractEventReturnType

Remarks​

This Action will batch up all the event logs found within the pollingInterval, and invoke them via onLogs.

watchContractEvent will attempt to create an Event Filter and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. eth_newFilter), then watchContractEvent will fall back to using getLogs instead.

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = client.watchContractEvent({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['event Transfer(address indexed from, address indexed to, uint256 value)']),
eventName: 'Transfer',
args: { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' },
onLogs: (logs) => console.log(logs),
})
watchEvent()​

watchEvent: <TAbiEvent, TAbiEvents, TStrict>(args) => WatchEventReturnType

Watches and returns emitted Event Logs.

Type parameters​

• TAbiEvent extends undefined | AbiEvent = undefined

• TAbiEvents extends undefined | readonly unknown[] | readonly AbiEvent[] = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined

• TStrict extends undefined | boolean = undefined

Parameters​

• args: WatchEventParameters<TAbiEvent, TAbiEvents, TStrict, Transport>

WatchEventParameters

Returns​

WatchEventReturnType

A function that can be invoked to stop watching for new Event Logs. WatchEventReturnType

Remarks​

This Action will batch up all the Event Logs found within the pollingInterval, and invoke them via onLogs.

watchEvent will attempt to create an Event Filter and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. eth_newFilter), then watchEvent will fall back to using getLogs instead.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = client.watchEvent({
onLogs: (logs) => console.log(logs),
})
watchPendingTransactions()​

watchPendingTransactions: (args) => WatchPendingTransactionsReturnType

Watches and returns pending transaction hashes.

Parameters​

• args: WatchPendingTransactionsParameters<Transport>

WatchPendingTransactionsParameters

Returns​

WatchPendingTransactionsReturnType

A function that can be invoked to stop watching for new pending transaction hashes. WatchPendingTransactionsReturnType

Remarks​

This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = await client.watchPendingTransactions({
onTransactions: (hashes) => console.log(hashes),
})

Inherited from​

HolographBaseContract.getClientByChainId

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:198

getGasPrice()​

getGasPrice(chainId): Promise<bigint>

Get the current gas price for a certain network.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<bigint>

The gas price in wei.

Inherited from​

HolographBaseContract.getGasPrice

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:208

getHolographByNetworks()​

readonly getHolographByNetworks(chainIds?): Promise<HolographByNetworksResponse>

Get the Holograph Protocol contract address by network. This contract stores a reference to all the primary modules and variables of the protocol.

Parameters​

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the Holograph contract address per network.

Source​

packages/sdk/src/contracts/operator.contract.ts:207

getJobDetails()​

readonly getJobDetails(chainId, jobHash): Promise<string | string[]>

Get the details for an available operator job.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• jobHash: 0x${string}

keccak256 hash of the job.

Returns​

Promise<string | string[]>

an OperatorJob struct with details about a specific job.

Source​

packages/sdk/src/contracts/operator.contract.ts:86

getMessageFee()​

readonly getMessageFee(chainId, toChain, gasLimit, gasPrice, crossChainPayload): Promise<string | string[]>

Get the fees associated with sending specific payload. It will provide exact costs on protocol and message side, combine the two to get total.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• toChain: number

The Holograph chain id of destination chain for payload.

• gasLimit: bigint

The amount of gas to provide for executing payload on destination chain.

• gasPrice: bigint

The maximum amount to pay for gas price, can be set to 0 and will be chose automatically.

• crossChainPayload: 0x${string}

The entire packet being sent cross-chain.

Returns​

Promise<string | string[]>

stringifiedFeesArray The compound fees [hlfFee, msgFee, dstGasPrice]: hlgFee: The amount (in wei) of native gas token that will cost for finalizing job on destination chain. msgFee: The amount (in wei) of native gas token that will cost for sending message to destination chain. dstGasPrice: The amount (in wei) that destination message maximum gas price will be.

Source​

packages/sdk/src/contracts/operator.contract.ts:309

getMessagingModule()​

readonly getMessagingModule(chainId): Promise<string | string[]>

Get the address of the Holograph Message Module

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<string | string[]>

The Message Module address to which all cross-chain message requests will be forwarded.

Source​

packages/sdk/src/contracts/operator.contract.ts:196

getMessagingModuleByNetworks()​

readonly getMessagingModuleByNetworks(chainIds?): Promise<HolographByNetworksResponse>

Get the address of the Holograph Messaging Module by network. All cross-chain message requests will get forwarded to this address.

Parameters​

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

The Holograph Messaging Module contract address per network.

Source​

packages/sdk/src/contracts/operator.contract.ts:260

getMinGasPrice()​

readonly getMinGasPrice(chainId): Promise<string | string[]>

Get the Minimum Gas Price.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<string | string[]>

The minimum value required to execute a job without it being marked as under priced.

Source​

packages/sdk/src/contracts/operator.contract.ts:186

getPaginatedPodOperators()​

readonly getPaginatedPodOperators(chainId, pod, index, length): Promise<string | string[]>

Get paginated list of operators in a pod.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• pod: number | bigint

the pod to query.

• index: number

the array index to start from.

• length: number

the length of result set to be (will be shorter if reached end of array).

Returns​

Promise<string | string[]>

operators a paginated array of operators.

Source​

packages/sdk/src/contracts/operator.contract.ts:131

getPodBondAmounts()​

readonly getPodBondAmounts(chainId, pod): Promise<string | string[]>

Check the base and current price for bonding to a particular pod.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• pod: number | bigint

the pod to get bonding amounts for.

Returns​

Promise<string | string[]>

base the base bond amount required for a pod.

current the current bond amount required for a pod.

Source​

packages/sdk/src/contracts/operator.contract.ts:143

getPodOperators()​

readonly getPodOperators(chainId, pod): Promise<string | string[]>

Get list of operators in a pod.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• pod: number | bigint

the pod to query.

Returns​

Promise<string | string[]>

operators array list of operators in a pod.

Source​

packages/sdk/src/contracts/operator.contract.ts:118

getPodOperatorsLength()​

readonly getPodOperatorsLength(chainId, pod): Promise<string | string[]>

Get total number of operators in a pod.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• pod: number | bigint

the pod to query.

Returns​

Promise<string | string[]>

total operators in a pod.

Source​

packages/sdk/src/contracts/operator.contract.ts:107

getRegistryByNetworks()​

readonly getRegistryByNetworks(chainIds?): Promise<HolographByNetworksResponse>

Get the Holograph Registry module by network. This module stores a reference for all deployed holographable smart contracts.

Parameters​

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

The Holograph Registry contract address per network.

Source​

packages/sdk/src/contracts/operator.contract.ts:242

getTotalPods()​

readonly getTotalPods(chainId): Promise<string | string[]>

Get number of pods available.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<string | string[]>

number of pods that have been opened via bonding.

Source​

packages/sdk/src/contracts/operator.contract.ts:96

getUtilityTokenByNetworks()​

readonly getUtilityTokenByNetworks(chainIds?): Promise<HolographByNetworksResponse>

Get the Holograph Utility Token address by network. This is the official utility token of the Holograph Protocol.

Parameters​

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

The Holograph Utility Token contract address per network.

Source​

packages/sdk/src/contracts/operator.contract.ts:281

jobEstimator()​

jobEstimator(chainId, bridgeInRequestPayload): Promise<string | string[]>

Calculates the amount of gas needed to execute a bridgeInRequest. Use this function to estimate the amount of gas that will be used by the bridgeInRequest function. Set a specific gas limit when making this call, subtract return value, to get total gas used.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• bridgeInRequestPayload: 0x${string}

The abi encoded bytes making up the bridgeInRequest payload.

Returns​

Promise<string | string[]>

The gas amount remaining after the static call is returned.

Source​

packages/sdk/src/contracts/operator.contract.ts:413

nonRevertingBridgeCall()​

nonRevertingBridgeCall(chainId, msgSender, payload, wallet?): Promise<string | string[]>

Purposefully made to be external so that Operator can call it during executeJob function.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• msgSender: 0x${string}

The address of who is sending the message.

• payload: 0x${string}

The entire cross chain message payload.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:375

recoverJob()​

recoverJob(chainId, bridgeInRequestPayload, wallet?): Promise<string | string[]>

Recovers a failed job. If a job fails, it can be manually recovered.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• bridgeInRequestPayload: 0x${string}

The entire cross chain message payload.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:353

send()​

send(chainId, gasLimit, gasPrice, toChain, nonce, holographableContract, bridgeOutPayload, wallet?): Promise<string | string[]>

Sends cross chain bridge request message. This function is restricted to only be callable by Holograph Bridge.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• gasLimit: bigint

The maximum amount of gas to spend for executing the bridge on destination chain.

• gasPrice: bigint

The maximum amount of gas price (in destination chain native gas token) to pay on destination chain.

• toChain: number

The Holograph Chain ID where the bridge is being sent to.

• nonce: bigint

The incremented number used to ensure job hashes are unique.

• holographableContract: 0x${string}

The address of the contract for which the bridge request is being made.

• bridgeOutPayload: 0x${string}

The bytes made up of the bridgeOutRequest payload.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:329

setBridge()​

Only Admin

setBridge(chainId, bridge, wallet?): Promise<string | string[]>

Updates the Holograph Bridge module address.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• bridge: 0x${string}

The address of the Holograph Bridge smart contract to use.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:478

setHolograph()​

Only Admin

setHolograph(chainId, holograph, wallet?): Promise<string | string[]>

Updates the Holograph Protocol contract address.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• holograph: 0x${string}

The address of the Holograph Protocol smart contract to use.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:489

setInterfaces()​

Only Admin

setInterfaces(chainId, interfaces, wallet?): Promise<string | string[]>

Updates the Holograph Interfaces module address.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• interfaces: 0x${string}

The address of the Holograph Interfaces smart contract to use.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:500

setMessagingModule()​

Only Admin

setMessagingModule(chainId, messagingModule, wallet?): Promise<string | string[]>

Updates the Holograph Messaging Module address.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• messagingModule: 0x${string}

The address of the LayerZero Endpoint to use.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:511

setMinGasPrice()​

Only Admin

setMinGasPrice(chainId, minGasPrice, wallet?): Promise<string | string[]>

Updates the Minimum Gas Price.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• minGasPrice: bigint

The amount to set for minimum gas price.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:544

setRegistry()​

Only Admin

setRegistry(chainId, registry, wallet?): Promise<string | string[]>

Updates the Holograph Registry module address.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• registry: 0x${string}

The address of the Holograph Registry smart contract to use.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:522

setUtilityToken()​

Only Admin

setUtilityToken(chainId, utilityToken, wallet?): Promise<string | string[]>

Updates the Holograph Utility Token address.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• utilityToken: 0x${string}

The address of the Holograph Utility Token smart contract to use.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:533

simulateContractFunction()​

simulateContractFunction(__namedParameters): Promise<any>

Parameters​

• __namedParameters: SimulateContractFunctionArgs<[object, object, object, object]>

Returns​

Promise<any>

Source​

packages/sdk/src/contracts/operator.contract.ts:69

topupUtilityToken()​

topupUtilityToken(chainId, operator, amount, wallet?): Promise<string | string[]>

Topup a bonded operator with more utility tokens. Useful function if an operator got slashed and wants to add a safety buffer to not get unbonded. This function will not work if operator has currently been selected for a job.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• operator: 0x${string}

The address of operator to topup.

• amount: bigint

The utility token amount to add.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:426

unbondUtilityToken()​

unbondUtilityToken(chainId, operator, recipient, wallet?): Promise<string | string[]>

Unbonds HLG utility tokens and stop being an operator. A bonded operator selected for a job cannot unbond until they complete the job, or are slashed.

Parameters​

• chainId: number

The chain id of the network to send the transaction.

• operator: 0x${string}

The address of operator to unbond.

• recipient: 0x${string}

The address where to send the bonded tokens.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/operator.contract.ts:462

validateWallet()​

protected validateWallet(wallet?): HolographWallet

Parameters​

• wallet?: HolographWallet | object

Returns​

HolographWallet

Inherited from​

HolographBaseContract.validateWallet

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:54